Human Services Data Specification (HSDS) OpenAPI Spec v1.1 DRAFT

This is the OpenAPI definiton for the Human Services Data Specification (v1.1 DRAFT). It is available as an HTML list or YAML OpenAPI Specifications, as well as a screen for the schema, conversation around it's evolution, and a diff screen between v1.0 and v1.1. If you are looking for the schema for HSDS, there is it is maintained by separate group in a Github repository, with the documentation published here..

Contacts
Get Contacts /contacts/ GET
Request Parameters:
page: The particular page of results.
per_page: Amount of locations to return per page, up to 100.
Reponse Body: ()
Create Contact /contacts/ POST
Request Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Get Contact /contacts/{contact_id}/ GET
Path Parameters:
contact_id: The contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Update Contact /contacts/{contact_id}/ PUT
Request Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Delete Contact /contacts/{contact_id}/ DELETE
Path Parameters:
contact_id: The contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Contact - Phones
Get Phones /contacts/{contact_id}/phones/ GET
Path Parameters:
contact_id: The unique contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Add Phone /contacts/{contact_id}/phones/ POST
Path Parameters:
contact_id: The unique contact id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Get Phone /contacts/{contact_id}/phones/{phone_id}/ GET
Path Parameters:
contact_id: The unique contact id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Update Phone /contacts/{contact_id}/phones/{phone_id}/ PUT
Path Parameters:
contact_id: The unique contact id.
phone_id: The unique phone id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Delete Phone /contacts/{contact_id}/phones/{phone_id}/ DELETE
Path Parameters:
contact_id: The unique contact id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Locations
Get Locations /locations/ GET
Request Parameters:
page: The particular page of results.
per_page: Amount of locations to return per page, up to 100.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Add Location /locations/ POST
Request Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Get Location /locations/{location_id}/ GET
Path Parameters:
location_id: The location id.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Update Location /locations/{location_id}/ UPDATE
Path Parameters:
location_id: The unique location id.
Request Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Delete Location /locations/{location_id}/ DELETE
Path Parameters:
location_id: The location id.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Location - Holiday Schedule
Get Holiday Schedule /locations/{location_id}/holiday_schedule/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Add Holiday Schedule /locations/{location_id}/holiday_schedule/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Get Holiday Schedule /locations/{location_id}/holiday_schedule/{holiday_schedule_id}/ GET
Path Parameters:
location_id: The unique location id.
holiday_schedule_id: The unique holiday schedule id.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Update Holiday Schedule /locations/{location_id}/holiday_schedule/{holiday_schedule_id}/ PUT
Path Parameters:
location_id: The unique location id.
holiday_schedule_id: The unique holiday schedule id.
Request Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Delete Holiday Schedule /locations/{location_id}/holiday_schedule/{holiday_schedule_id}/ DELETE
Path Parameters:
location_id: The unique location id.
holiday_schedule_id: The unique holiday schdule id.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Location - Language
Get Languages /locations/{location_id}/languages/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Add Languages /locations/{location_id}/languages/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Get Languages /locations/{location_id}/languages/{language_id}/ GET
Path Parameters:
location_id: The unique location id.
language_id: The unique language id.
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Update Languages /locations/{location_id}/languages/{language_id}/ PUT
Path Parameters:
location_id: The unique location id.
language_id: The unique language id.
Request Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Delete Languages /locations/{location_id}/languages/{language_id}/ DELETE
Path Parameters:
location_id: The unique location id.
language_id: The unique language id.
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Location - Postal Address
Get Postal Address /locations/{location_id}/postal_address/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Add New Postal Adress /locations/{location_id}/postal_address/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Get Postal Address /locations/{location_id}/postal_address/{postal_address_id}/ GET
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Update Postal Address /locations/{location_id}/postal_address/{postal_address_id}/ PUT
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Request Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Delete Postal Address /locations/{location_id}/postal_address/{postal_address_id}/ DELETE
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Location - Physical Address
Get Physical Address /locations/{location_id}/physical_address/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Add New Physical Adress /locations/{location_id}/physical_address/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Get Physical Address /locations/{location_id}/physical_address/{postal_address_id}/ GET
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Update Physical Address /locations/{location_id}/physical_address/{postal_address_id}/ PUT
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Request Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Delete Physical Address /locations/{location_id}/physical_address/{postal_address_id}/ DELETE
Path Parameters:
location_id: The unique location id.
postal_address_id: The unique postal address id.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Location - Phones
Get Phones /locations/{location_id}/phones/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (postal_address)
id Each postal address must have a unique identifier.
location_id The identifier of the location for which this is the postal address.
attention The person or entity for whose attention mail should be marked.
address_1 The first line of the address.
address_2 The second line of the address.
address_3 The third line of the address.
address_4 The fourth line of the address.
city The city in which the address is located.
state_province The state or province in which the address is located.
postal_code The postal code for the address.
country The country in which the address is located.
Add Phone /locations/{location_id}/phones/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Get Phone /locations/{location_id}/phones/{phone_id}/ GET
Path Parameters:
location_id: The unique location id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Update Phone /locations/{location_id}/phones/{phone_id}/ PUT
Path Parameters:
location_id: The unique location id.
phone_id: The unique phone id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Delete Phone /locations/{location_id}/phones/{phone_id}/ DELETE
Path Parameters:
location_id: The unique location id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Location - Regular Schedule
Get Regular Schedule /locations/{location_id}/regular_schedule/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Add Regular Schedule /locations/{location_id}/regular_schedule/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Get Regular Schedule /locations/{location_id}/regular_schedule/{regular_schedule_id}/ GET
Path Parameters:
location_id: The unique location id.
regular_schedule_id: The unique regular schedule id.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Update Regular Schedule /locations/{location_id}/regular_schedule/{regular_schedule_id}/ PUT
Path Parameters:
location_id: The unique location id.
regular_schedule_id: The unique regular schedule id.
Request Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Delete Regular Schedule /locations/{location_id}/regular_schedule/{regular_schedule_id}/ DELETE
Path Parameters:
location_id: The unique location id.
regular_schedule_id: The unique regular schedule id.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Location - Services
Get Service /locations/{location_id}/services/ GET
Path Parameters:
location_id: The unique location id.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Add Service /locations/{location_id}/services/ POST
Path Parameters:
location_id: The unique location id.
Request Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Get Service /locations/{location_id}/services/{service_id}/ GET
Path Parameters:
location_id: The unique location id.
service_id: The unique service id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Update Service /locations/{location_id}/services/{service_id}/ PUT
Path Parameters:
location_id: The unique location id.
service_id: The unique service id.
Request Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Delete Service /locations/{location_id}/services/{service_id}/ DELETE
Path Parameters:
location_id: The unique location id.
service_id: The unique service id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Location - Accessibility For Disabilities
Get Accessibility For Disabilities /locations/{location_id}/accessibility_for_disabilities/ GET
Request Parameters:
country_prefix: The country prefix code, such as +1 for the USA.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Add Accessibility For Disabilities /locations/{location_id}/accessibility_for_disabilities/ POST
Request Parameters:
location_id: The unique location id.
Request Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Reponse Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Get Accessibility For Disabilities /locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/ GET
Request Parameters:
location_id: The unique location id.
Reponse Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Update Accessibility For Disabilities /locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/ PUT
Request Parameters:
accessibility_for_disabilities_id: The unique accessibility for disabilities id.
Request Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Reponse Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Delete Accessibility For Disabilities /locations/{location_id}/accessibility_for_disabilities/{accessibility_for_disabilities_id}/ DELETE
Request Parameters:
accessibility_for_disabilities_id: The unique accessibility for disabilities id.
location_id: The unique location id.
Reponse Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Metadata
Get Metadata /metadata/ GET
Reponse Body: (accessibility_for_disabilities)
id Each entry must have a unique identifier.
location_id The identifier of the location for which the entry describes the accessibility provision.
accessibility Description of assistance or infrastructure that facilitate access to clients with disabilities.
Add New Metadata /metadata/ POST
Request Parameters:
resource_id: The unique resource id.
Request Body: (metadata)
id Each entry must have a unique identifier.
resource_id Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs.
last_action_date The date when data was changed.
last_action_type The kind of change made to the data; eg create, update, delete.
field_name The name of field that has been modified.
previous_value The previous value of a field that has been updated.
replacement_value The new value of a field that has been updated.
updated_by The name of the person who updated a value.
Reponse Body: (metadata)
id Each entry must have a unique identifier.
resource_id Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs.
last_action_date The date when data was changed.
last_action_type The kind of change made to the data; eg create, update, delete.
field_name The name of field that has been modified.
previous_value The previous value of a field that has been updated.
replacement_value The new value of a field that has been updated.
updated_by The name of the person who updated a value.
Get Service /metadata/{metadata_id}/ GET
Path Parameters:
metadata_id: The metadata id.
Reponse Body: (metadata)
id Each entry must have a unique identifier.
resource_id Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs.
last_action_date The date when data was changed.
last_action_type The kind of change made to the data; eg create, update, delete.
field_name The name of field that has been modified.
previous_value The previous value of a field that has been updated.
replacement_value The new value of a field that has been updated.
updated_by The name of the person who updated a value.
Delete Metadata /metadata/{metadata_id}/ DELETE
Path Parameters:
metadata_id: The metadata id.
Reponse Body: (metadata)
id Each entry must have a unique identifier.
resource_id Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs.
last_action_date The date when data was changed.
last_action_type The kind of change made to the data; eg create, update, delete.
field_name The name of field that has been modified.
previous_value The previous value of a field that has been updated.
replacement_value The new value of a field that has been updated.
updated_by The name of the person who updated a value.
Organizations
Get Locations /organizations/ GET
Request Parameters:
page: The particular page of results.
per_page: Amount of locations to return per page, up to 100.
Reponse Body: (metadata)
id Each entry must have a unique identifier.
resource_id Each service, program. location, address, or contact will have a unique identifier. Unique ids are UUIDs.
last_action_date The date when data was changed.
last_action_type The kind of change made to the data; eg create, update, delete.
field_name The name of field that has been modified.
previous_value The previous value of a field that has been updated.
replacement_value The new value of a field that has been updated.
updated_by The name of the person who updated a value.
Create a new organization /organizations/ POST
Request Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Reponse Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Get Organization /organizations/{organization_id}/ GET
Path Parameters:
organization_id: The organization id.
Reponse Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Update Existing Organization /organizations/{organization_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
Request Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Reponse Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Delete Organization /organizations/{organization_id}/ DELETE
Path Parameters:
organization_id: The organization id.
Reponse Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Organization - Contacts
Get Contacts /organizations/{organization_id}/contacts/ GET
Path Parameters:
organization_id: The organization id.
Request Parameters:
accessibility: Accessibility options available at the location. Accepted values are cd, deaf_interpreter, disabled_parking, elevator, ramp, restroom, tape_braille, tty, wheelchair, and wheelchair_van.
address_attributes: required unless the location is marked as virtual
admin_emails: Email address for a person allowed to administer the location (via the Ohana API Admin interface for example).
alternate_name: Another name this location might be known by.
description: Description of services provided at the location
email: General Email address for location. Emails that belong to contacts should go in the Contact object.
languages: Languages spoken at the location
latitude: Latitude portion of the location’s coordinates. Note that the app automatically geocodes addresses if the data doesn’t include coordinates
longitude: Longitude portion of the location’s coordinates. Note that the app automatically geocodes addresses if the data doesn’t include coordinates
name: Name of the location
short_desc: Succinct description of services provided at the location.
transportation: Public transportation options near the location
virtual: required if the location does not have a physical address
website: The location’s website. Must include “http://” or “https://”
Reponse Body: (organization)
id Each organization must have a unique identifier.
name The official or public name of the organization.
alternate_name Alternative or commonly used name for the organization.
description A brief summary about the organization. It can contain markup such as HTML or Markdown.
email The contact e-mail address for the organization.
url The URL (website address) of the organization.
tax_status Government assigned tax designation for for tax-exempt organizations.
tax_id A government issued identifier used for the purpose of tax administration.
year_incorporated The year in which the organization was legally formed.
legal_status The legal status defines the conditions that an organization is operating under; e.g. non-profit, private corporation or a government organization.
Add Contact /organizations/{organization_id}/contacts/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Get Contact /organizations/{organization_id}/contacts/{contact_id}/ GET
Path Parameters:
organization_id: The unique organization id.
contact_id: The unique contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Update Contact /organizations/{organization_id}/contacts/{contact_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
contact_id: The unique contact id.
Request Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Delete Contact /organizations/{organization_id}/contacts/{contact_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
contact_id: The unique contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Organization - Funding
Get Funding /organizations/{organization_id}/funding/ GET
Path Parameters:
organization_id: The unique organization id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Add Funding /organizations/{organization_id}/funding/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Get Funding /organizations/{organization_id}/funding/{funding_id}/ GET
Path Parameters:
organization_id: The unique organization id.
funding_id: The unique funding id.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Update Funding /organizations/{organization_id}/funding/{funding_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
funding_id: The unique funding id.
Request Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Delete Funding /organizations/{organization_id}/funding/{funding_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
funding_id: The unique funding id.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Organization - Locations
Get Location /organizations/{organization_id}/locations/ GET
Path Parameters:
organization_id: The id for the organization.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Create a new location /organizations/{organization_id}/locations/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Update Existing Location /organizations/{organization_id}/locations/{location_id}/ GET
Path Parameters:
organization_id: The unique organization id.
location_id: The unique location id.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Create a new location /organizations/{organization_id}/locations/{location_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
location_id: The unique location id.
Request Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Delete Location /organizations/{organization_id}/locations/{location_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
location_id: The unique location id.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Organization - Phones
Get Phones /organizations/{organization_id}/phones/ GET
Path Parameters:
organization_id: The unique organization id.
Reponse Body: (location)
id Each location must have a unique identifier.
organization_id Each location must belong to a single organization. The identifier of the organization should be given here.
name The name of the location.
alternate_name An alternative name for the location.
description A description of this location.
transportation A description of the access to public or private transportation to and from the location.
latitude Y coordinate of location expressed in decimal degrees in WGS84 datum.
longitude X coordinate of location expressed in decimal degrees in WGS84 datum.
Add Phone /organizations/{organization_id}/phones/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Get Phone /organizations/{organization_id}/phones/{phone_id}/ GET
Path Parameters:
organization_id: The unique organization id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Update Phone /organizations/{organization_id}/phones/{phone_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
phone_id: The unique phone id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Delete Phone /organizations/{organization_id}/phones/{phone_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Organization - Programs
Get Programs /organizations/{organization_id}/programs/ GET
Path Parameters:
organization_id: The unique organization id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Add Program /organizations/{organization_id}/programs/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Reponse Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Get Program /organizations/{organization_id}/programs/{program_id}/ GET
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Reponse Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Update Program /organizations/{organization_id}/programs/{program_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Request Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Reponse Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Delete Program /organizations/{organization_id}/programs/{program_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Reponse Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Organization - Program Services
Get Service /organizations/{organization_id}/programs/{program_id}/services/ GET
Path Parameters:
organization_id: The unique organization id.
Reponse Body: (program)
id Each program must have a unique identifier.
organization_id Each program must belong to a single organization. The identifier of the organization should be given here.
name The name of the program.
alternate_name NeAn alternative name for the program.
Add Service /organizations/{organization_id}/programs/{program_id}/services/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Get Service /organizations/{organization_id}/programs/{program_id}/services/{service_id}/ GET
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Update Service /organizations/{organization_id}/programs/{program_id}/services/{service_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Request Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Delete Service /organizations/{organization_id}/programs/{program_id}/services/{service_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Organization - Services
Get Services /organizations/{organization_id}/services/ GET
Path Parameters:
organization_id: The unique organization id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Add Service /organizations/{organization_id}/services/ POST
Path Parameters:
organization_id: The unique organization id.
Request Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Get Service /organizations/{organization_id}/services/{service_id}/ GET
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Update Service /organizations/{organization_id}/services/{service_id}/ PUT
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Request Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Delete Service /organizations/{organization_id}/services/{service_id}/ DELETE
Path Parameters:
organization_id: The unique organization id.
program_id: The unique program id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Search
Get locations that match certain criteria. /search/ GET
Request Parameters:
category:
email:
keyword:
language:
lat_lng:
location:
org_name:
page:
per_page:
radius:
service_area:
status:
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Service - Contacts
Get Contacts /services/{service_id}/contacts/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (service)
id Each service must have a unique identifier.
organization_id The identifier of the organization that provides this service.
program_id The identifier of the program this service is delivered under.
location_id The identifier of the location where this service is delivered.
name The official or public name of the service.
alternate_name Alternative or commonly used name for a service.
description A description of the service.
url URL of the service.
email Email address for the service.
status The current status of the service.
application_process The steps needed to access the service.
wait_time Time a client may expect to wait before receiving a service.
taxonomy_ids A comma separated list of identifiers from the taxonomy table.
Add Contact /services/{service_id}/contacts/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Get Contact /services/{service_id}/contacts/{contact_id}/ GET
Path Parameters:
service_id: The unique service id.
contact_id: The unique contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Update Contact /services/{service_id}/contacts/{contact_id}/ PUT
Path Parameters:
service_id: The unique service id.
contact_id: The unique contact id.
Request Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Delete Contact /services/{service_id}/contacts/{contact_id}/ DELETE
Path Parameters:
service_id: The unique service id.
contact_id: The unique contact id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Service - Eligibility
Get Eligibility /services/{service_id}/eligibility/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (contact)
id Each contact must have a unique identifier.
organization_id The identifier of the organization for which this is a contact.
service_id The identifier of the service for which this is a contact.
name The name of the person.
title The job title of the person.
department The department that the person is part of.
email The email address of the person.
Add Eligibility /services/{service_id}/eligibility/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Reponse Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Get Eligibility /services/{service_id}/eligibility/{eligibility_id}/ GET
Path Parameters:
eligibility_id: The unique eligibility id.
service_id: The unique service id.
Reponse Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Update Eligibility /services/{service_id}/eligibility/{eligibility_id}/ PUT
Path Parameters:
eligibility_id: The unique eligibility id.
service_id: The unique service id.
Request Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Reponse Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Eligibility Contact /services/{service_id}/eligibility/{eligibility_id}/ DELETE
Path Parameters:
eligibility_id: The unique eligibility id.
service_id: The unique service id.
Reponse Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Service - Fees
Get Fees /services/{service_id}/fees/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (eligibility)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the eligibility criteria.
eligibility The rules or guidelines that determine who can receive the service.
Add Fees /services/{service_id}/fees/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Reponse Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Get Fees /services/{service_id}/fees/{feed_id}/ GET
Path Parameters:
service_id: The unique service id.
feed_id: The unique feed id.
Reponse Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Update Fees /services/{service_id}/fees/{feed_id}/ PUT
Path Parameters:
service_id: The unique service id.
feed_id: The unique feed id.
Request Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Reponse Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Eligibility Fees /services/{service_id}/fees/{feed_id}/ DELETE
Path Parameters:
service_id: The unique service id.
feed_id: The unique feed id.
Reponse Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Service - Funding
Get Funding /services/{service_id}/funding/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (fee)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this entry describes the costs of service.
fee A listing of the costs of services, including free ones.
Add Funding /services/{service_id}/funding/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Get Funding /services/{service_id}/funding/{funding_id}/ GET
Path Parameters:
service_id: The unique service id.
funding_id: The unique funding id.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Update Funding /services/{service_id}/funding/{funding_id}/ PUT
Path Parameters:
service_id: The unique service id.
funding_id: The unique funding id.
Request Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Delete Funding /services/{service_id}/funding/{funding_id}/ DELETE
Request Parameters:
service_id: The unique service id.
funding_id: The unique funding id.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Service - Holiday Schedule
Get Holiday Schedule /services/{service_id}/holiday_schedule/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (funding)
id Each entry must have a unique identifier.
organization_id The identifier of the organization for which this entry describes the source of funding.
service_id The identifier of the service for which this entry describes the source of funding.
source Source of funds for organization or service.
Add Holiday Schedule /services/{service_id}/holiday_schedule/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Get Holiday Schedule /services/{service_id}/holiday_schedule/{holiday_schedule_id}/ GET
Path Parameters:
service_id: The unique service id.
holiday_schedule_id: The unique holiday schedule id.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Update Holiday Schedule /services/{service_id}/holiday_schedule/{holiday_schedule_id}/ PUT
Path Parameters:
service_id: The unique service id.
holiday_schedule_id: The unique holiday schedule id.
Request Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Delete Holiday Schedule /services/{service_id}/holiday_schedule/{holiday_schedule_id}/ DELETE
Path Parameters:
service_id: The unique service id.
holiday_schedule_id: The unique holiday schedule id.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Service - Interpretation Services
Get Interpretation Services /services/{service_id}/intepretation_services/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (holiday_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the holiday schedule.
location_id The identifier of the location for which this is the holiday schedule.
closed Indicates if a service or location is closed during a public holiday.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location closes. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
start_date The first day that a service or location is closed during a public or private holiday.
end_date The last day that a service or location is closed during a public or private holiday.
Add Interpretation Services /services/{service_id}/intepretation_services/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Reponse Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Get Interpretation Services /services/{service_id}/intepretation_services/{intepretation_services_id}/ GET
Path Parameters:
service_id: The unique service id.
intepretation_services_id: The unique interpretation services id.
Reponse Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Update Interpretation Services /services/{service_id}/intepretation_services/{intepretation_services_id}/ PUT
Path Parameters:
service_id: The unique service id.
intepretation_services_id: The unique interpretation services id.
Request Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Reponse Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Delete Interpretation Services /services/{service_id}/intepretation_services/{intepretation_services_id}/ DELETE
Path Parameters:
service_id: The unique service id.
intepretation_services_id: The unique interpretation services id.
Reponse Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Service - Languages
Get Languages /services/{service_id}/languages/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (intepretation_services)
id Each service must have a unique identifier.
service_id The identifier of the services for which the entry describes the interpretation services available.
language Languages, other than English, for which interpretation is available. Languages are listed as ISO639-1 codes.
Add Languages /services/{service_id}/languages/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Get Languages /services/{service_id}/languages/{language_id}/ GET
Path Parameters:
service_id: The unique service id.
language_id: The unique language id.
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Update Languages /services/{service_id}/languages/{language_id}/ PUT
Path Parameters:
service_id: The unique service id.
language_id: The unique language id.
Request Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Delete Languages /services/{service_id}/languages/{language_id}/ DELETE
Path Parameters:
service_id: The unique service id.
language_id: The unique language id.
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Service - Payment Accepted
Get Payment Accepted /services/{service_id}/payment_accepted/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (language)
id Each language must have a unique identifier.
service_id The identifier of the service for which the entry describes the languages in which services are delivered.
location_id The identifier of the location for which the entry describes the languages in which services are delivered.
language Languages, other than English, in which the service is delivered. Languages are listed as ISO639-1 codes..
Add Payment Accepted /services/{service_id}/payment_accepted/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Reponse Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Get Payment Accepted /services/{service_id}/payment_accepted/{payment_accepted_id}/ GET
Path Parameters:
service_id: The unique service id.
payment_accepted_id: The unique payment accepted id.
Reponse Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Update Payment Accepted /services/{service_id}/payment_accepted/{payment_accepted_id}/ PUT
Path Parameters:
service_id: The unique service id.
payment_accepted_id: The unique payment accepted id.
Request Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Reponse Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Delete Payment Accepted /services/{service_id}/payment_accepted/{payment_accepted_id}/ DELETE
Path Parameters:
service_id: The unique service id.
payment_accepted_id: The unique payment accepted id.
Reponse Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Service - Phones
Get Phones /services/{service_id}/phones/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (payment_accepted)
id Each entry must have a unique identifier.
service_id The identifier of the services for which the entry describes the accepted payment methods.
payment The methods of payment accepted for the service.
Add Phone /services/{service_id}/phones/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Get Phone /services/{service_id}/phones/{phone_id}/ GET
Path Parameters:
service_id: The unique service id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Update Phone /services/{service_id}/phones/{phone_id}/ PUT
Path Parameters:
service_id: The unique service id.
phone_id: The unique phone id.
Request Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Delete Phone /services/{service_id}/phones/{phone_id}/ DELETE
Path Parameters:
service_id: The unique service id.
phone_id: The unique phone id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Service - Regular Schedule
Get Regular Schedule /services/{service_id}/regular_schedule/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (phone)
id Each entry must have a unique identifier.
location_id The identifier of the location where this phone number is located.
service_id The identifier of the service for which this is the phone number.
organization_id The identifier of the organisation for which this is the phone number.
contact_id The identifier of the contact for which this is the phone number.
number The phone number.
extension The extension of the phone number.
type Whether the phone number relates to a fixed or cellular phone.
department The department for which this is the phone number.
Add Regular Schedule /services/{service_id}/regular_schedule/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Get Regular Schedule /services/{service_id}/regular_schedule/{required_document_id}/ GET
Path Parameters:
service_id: The unique service id.
regular_schedule_id: The unique regular schedule id.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Update Regular Schedule /services/{service_id}/regular_schedule/{required_document_id}/ PUT
Path Parameters:
service_id: The unique service id.
regular_schedule_id: The unique regular schedule id.
Request Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Delete Regular Schedule /services/{service_id}/regular_schedule/{required_document_id}/ DELETE
Path Parameters:
service_id: The unique service id.
regular_schedule_id: The unique regular schedule id.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Service - Required Document
Get Required Document /services/{service_id}/required_document/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (regular_schedule)
id Each entry must have a unique identifier.
service_id The identifier of the service for which this is the regular schedule.
location_id The identifier of the location for which this is the regular schedule.
weekday The day of the week that this entry relates to.
opens_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
closes_at The time when a service or location opens. This should use HH:MM format and should include timezone information, either adding the suffix ‘Z’ when the date is in UTC, or including an offset from UTC (e.g. 09:00-05:00 for 9am East Coast Time.
Add Required Document /services/{service_id}/required_document/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Reponse Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Get Required Document /services/{service_id}/required_document/{required_document_id}/ GET
Path Parameters:
service_id: The unique service id.
required_document_id: The unique required document id.
Reponse Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Update Required Document /services/{service_id}/required_document/{required_document_id}/ PUT
Path Parameters:
service_id: The unique service id.
required_document_id: The unique required document id.
Request Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Reponse Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Delete Required Document /services/{service_id}/required_document/{required_document_id}/ DELETE
Path Parameters:
service_id: The unique service id.
required_document_id: The unique required document id.
Reponse Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Service - Areas
Get Service Area /services/{service_id}/service_area/ GET
Path Parameters:
service_id: The unique service id.
Reponse Body: (required_document)
id Each document must have a unique identifier.
service_id The identifier of the service for which this entry describes the required document.
document The document required to apply for or receive the service. e.g. Government-issued ID, EU Passport.
Add Service Area /services/{service_id}/service_area/ POST
Path Parameters:
service_id: The unique service id.
Request Body: (service_area)
id Each service area must have a unique identifier.
service_id The identifier of the service for which this entry describes the service area.
service_area The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.
Reponse Body: (service_area)
id Each service area must have a unique identifier.
service_id The identifier of the service for which this entry describes the service area.
service_area The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.
Get Service Area /services/{service_id}/service_area/{service_area_id}/ GET
Path Parameters:
service_id: The unique service id.
service_area_id: The unique service area id.
Reponse Body: (service_area)
id Each service area must have a unique identifier.
service_id The identifier of the service for which this entry describes the service area.
service_area The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.
Update Service Area /services/{service_id}/service_area/{service_area_id}/ PUT
Path Parameters:
service_id: The unique service id.
service_area_id: The unique service area id.
Request Body: (service_area)
id Each service area must have a unique identifier.
service_id The identifier of the service for which this entry describes the service area.
service_area The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.
Reponse Body: (service_area)
id Each service area must have a unique identifier.
service_id The identifier of the service for which this entry describes the service area.
service_area The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.
Delete Service Area /services/{service_id}/service_area/{service_area_id}/ DELETE
Path Parameters:
service_id: The unique service id.
service_area_id: The unique service area id.
Reponse Body: (service_area)
id Each service area must have a unique identifier.
service_id The identifier of the service for which this entry describes the service area.
service_area The geographic area where a service is available. This is a free-text description, and so may be precise or indefinite as necessary.